<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>gps: E:/CODING/arduino-1.0/libraries/gps/gps.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">gps
   &#160;<span id="projectnumber">1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Macros</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_6ef22761b4862fd593205c95f7ac3a3d.html">CODING</a></li><li class="navelem"><a class="el" href="dir_a23ad32c709cbe4d21e2bb7aa37b6a3a.html">arduino-1.0</a></li><li class="navelem"><a class="el" href="dir_c17db4ac16776378fe75e5aa45b7fade.html">libraries</a></li><li class="navelem"><a class="el" href="dir_5dae2307f95cc4f8fc1bc98b3ac5969e.html">gps</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a>  </div>
  <div class="headertitle">
<div class="title">gps.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Header for GPS utility library <a class="el" href="gps_8cpp.html" title="GPS utility library.">gps.cpp</a>.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="gps__setup_8h_source.html">gps_setup.h</a>&quot;</code><br/>
<code>#include &quot;Arduino.h&quot;</code><br/>
</div>
<p><a href="gps_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgps.html">gps</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">gps class  <a href="classgps.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgps_1_1_r_m_cstr.html">gps::RMCstr</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Struct to work with $GPRMC string.  <a href="structgps_1_1_r_m_cstr.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgps_1_1time__s.html">gps::time_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">time struct  <a href="structgps_1_1time__s.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgps_1_1date__s.html">gps::date_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">date struct  <a href="structgps_1_1date__s.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgps_1_1_gps_info__s.html">gps::GpsInfo_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">General gps info.  <a href="structgps_1_1_gps_info__s.html#details">More...</a><br/></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgps_1_1channel__s.html">gps::channel_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">channel information  <a href="structgps_1_1channel__s.html#details">More...</a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a1daf785e3f68d293c7caa1c756d5cb74"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1daf785e3f68d293c7caa1c756d5cb74"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#a1daf785e3f68d293c7caa1c756d5cb74">pi</a>&#160;&#160;&#160;3.14159265</td></tr>
<tr class="memdesc:a1daf785e3f68d293c7caa1c756d5cb74"><td class="mdescLeft">&#160;</td><td class="mdescRight">pi <br/></td></tr>
<tr class="memitem:a5c71a5e59a53413cd6c270266d63b031"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c71a5e59a53413cd6c270266d63b031"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#a5c71a5e59a53413cd6c270266d63b031">R</a>&#160;&#160;&#160;6371</td></tr>
<tr class="memdesc:a5c71a5e59a53413cd6c270266d63b031"><td class="mdescLeft">&#160;</td><td class="mdescRight">Earth's radius. <br/></td></tr>
<tr class="memitem:ab5d59680aa9d3d5739abf9842e87b455"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#ab5d59680aa9d3d5739abf9842e87b455">TYPE_LAT</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:ab5d59680aa9d3d5739abf9842e87b455"><td class="mdescLeft">&#160;</td><td class="mdescRight">Latitude type.  <a href="#ab5d59680aa9d3d5739abf9842e87b455"></a><br/></td></tr>
<tr class="memitem:a1d27c1fc0ada9dc33440b4f88b1a5ef0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#a1d27c1fc0ada9dc33440b4f88b1a5ef0">TYPE_LON</a>&#160;&#160;&#160;2</td></tr>
<tr class="memdesc:a1d27c1fc0ada9dc33440b4f88b1a5ef0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Longitute type.  <a href="#a1d27c1fc0ada9dc33440b4f88b1a5ef0"></a><br/></td></tr>
<tr class="memitem:a63fa90f191fafc997382f5c813d0da97"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#a63fa90f191fafc997382f5c813d0da97">NMEA_RMC</a>&#160;&#160;&#160;1</td></tr>
<tr class="memdesc:a63fa90f191fafc997382f5c813d0da97"><td class="mdescLeft">&#160;</td><td class="mdescRight">NMEA TYPE RMC.  <a href="#a63fa90f191fafc997382f5c813d0da97"></a><br/></td></tr>
<tr class="memitem:a28a8dd0c639c486c4b3b57427a8e4719"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#a28a8dd0c639c486c4b3b57427a8e4719">NMEA_PMTKCHN</a>&#160;&#160;&#160;2</td></tr>
<tr class="memdesc:a28a8dd0c639c486c4b3b57427a8e4719"><td class="mdescLeft">&#160;</td><td class="mdescRight">NMEA TYPE MTK CHN.  <a href="#a28a8dd0c639c486c4b3b57427a8e4719"></a><br/></td></tr>
<tr class="memitem:ae4b48f90c078751cbbb179b2d85d6f73"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#ae4b48f90c078751cbbb179b2d85d6f73">NMEA_ERR_FORMAT</a>&#160;&#160;&#160;(-1)</td></tr>
<tr class="memdesc:ae4b48f90c078751cbbb179b2d85d6f73"><td class="mdescLeft">&#160;</td><td class="mdescRight">format error  <a href="#ae4b48f90c078751cbbb179b2d85d6f73"></a><br/></td></tr>
<tr class="memitem:a2251ae7c698ee31e61e606085442c9e7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gps_8h.html#a2251ae7c698ee31e61e606085442c9e7">NMEA_ERR_CHECKSUM</a>&#160;&#160;&#160;(-2)</td></tr>
<tr class="memdesc:a2251ae7c698ee31e61e606085442c9e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">checksum error  <a href="#a2251ae7c698ee31e61e606085442c9e7"></a><br/></td></tr>
<tr class="memitem:a00badda859abd358ff02da5d62808214"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00badda859abd358ff02da5d62808214"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>VALID_ACTIVE</b>&#160;&#160;&#160;0x41</td></tr>
<tr class="memitem:af5841d112d2ffeacb8df9aee472d4a4e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af5841d112d2ffeacb8df9aee472d4a4e"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>VALID_VOID</b>&#160;&#160;&#160;0x56</td></tr>
<tr class="memitem:af142eb0359710cff0b4345efdbcfc08f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af142eb0359710cff0b4345efdbcfc08f"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MODE_AUTONOMOUS</b>&#160;&#160;&#160;0x41</td></tr>
<tr class="memitem:a341a9baa08bbf11639ce73dc87beaf13"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a341a9baa08bbf11639ce73dc87beaf13"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MODE_DIFFERENTIAL</b>&#160;&#160;&#160;0x44</td></tr>
<tr class="memitem:a20ff5cf330f7f0d9a05b811c9b08206d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a20ff5cf330f7f0d9a05b811c9b08206d"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>MODE_ESTIMATED</b>&#160;&#160;&#160;0x45</td></tr>
<tr class="memitem:af98456070a63f454dbd60f56a7907616"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af98456070a63f454dbd60f56a7907616"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>TOTAL_CHANNEL</b>&#160;&#160;&#160;(66)</td></tr>
<tr class="memitem:a7ceb2742d3d40fda66d2730f3ae10077"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7ceb2742d3d40fda66d2730f3ae10077"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>STATUS_CHN_IDLE</b>&#160;&#160;&#160;0</td></tr>
<tr class="memitem:ac821a286e5ee9452d5db6b182907ae5e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac821a286e5ee9452d5db6b182907ae5e"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>STATUS_CHN_SEARCHING</b>&#160;&#160;&#160;1</td></tr>
<tr class="memitem:aa259e399b3e1f4f52e4e89d0490da818"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa259e399b3e1f4f52e4e89d0490da818"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>STATUS_CHN_TRACKING</b>&#160;&#160;&#160;2</td></tr>
<tr class="memitem:a334a01991f3b3b1dc58184667c0b9870"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a334a01991f3b3b1dc58184667c0b9870"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>gps_h</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Header for GPS utility library <a class="el" href="gps_8cpp.html" title="GPS utility library.">gps.cpp</a>. </p>
</div><hr/><h2>Macro Definition Documentation</h2>
<a class="anchor" id="a2251ae7c698ee31e61e606085442c9e7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define NMEA_ERR_CHECKSUM&#160;&#160;&#160;(-2)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>checksum error </p>
<p>NMEA string has failed the checksum. </p>

</div>
</div>
<a class="anchor" id="ae4b48f90c078751cbbb179b2d85d6f73"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define NMEA_ERR_FORMAT&#160;&#160;&#160;(-1)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>format error </p>
<p>NMEA string has wrong format. </p>

</div>
</div>
<a class="anchor" id="a28a8dd0c639c486c4b3b57427a8e4719"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define NMEA_PMTKCHN&#160;&#160;&#160;2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>NMEA TYPE MTK CHN. </p>
<p>NMEA TYPE MTK CHN, GPS Channel information. <a href="http://snoob-community.wikispaces.com/PMTKCHN">http://snoob-community.wikispaces.com/PMTKCHN</a> </p>

</div>
</div>
<a class="anchor" id="a63fa90f191fafc997382f5c813d0da97"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define NMEA_RMC&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>NMEA TYPE RMC. </p>
<p>NMEA TYPE RMC, Recommended minimum data. <a href="http://www.gpsinformation.org/dale/nmea.htm#RMC">http://www.gpsinformation.org/dale/nmea.htm#RMC</a> </p>

</div>
</div>
<a class="anchor" id="ab5d59680aa9d3d5739abf9842e87b455"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TYPE_LAT&#160;&#160;&#160;1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Latitude type. </p>
<p>Latitude type. To be used in Function 'dmtodd', param 'LatOrLon' </p>

</div>
</div>
<a class="anchor" id="a1d27c1fc0ada9dc33440b4f88b1a5ef0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define TYPE_LON&#160;&#160;&#160;2</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Longitute type. </p>
<p>Longitude Type. To be used in Function 'dmtodd', param 'LatOrLon' </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat May 26 2012 18:48:47 for gps by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1
</small></address>
</body>
</html>
